home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / arexx / arexg10c.lha / ARexxGuide / Extras / ExtraFiles.README < prev   
Encoding:
Text File  |  1993-10-16  |  2.4 KB  |  60 lines
  1. The files in this directory are not needed to run ARexxGuide, but
  2. might be helpful to some users. These files are included:
  3.  
  4.   ARexxGuide                       ARexxGuide.info
  5.   ARexxGuide.rexx                  ARx_Guide.xref
  6.   ARx_Help.rexx                    ARx_Help.TTX
  7.  
  8.  ARexxGuide.rexx ARexxGuide & ARexxGuide.info
  9.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10. I use these files to start the guide. They require that certain
  11. environmental variables be set, but the script will attempt to set
  12. the variables if they are not present.
  13.  
  14. The script uses functions from "rexxarplib.library" to help the
  15. user set up the system. Although it can handle a system that
  16. doesn't have "rexxarplib," it isn't pretty. Once the system is set
  17. up, though, rexxarplib is no longer needed for this file.
  18.  
  19. This script uses the .xref file which is explained below.
  20.  
  21. The launch script and .xref files were especially helpful during
  22. development, before full paths were added to the link points. The
  23. .rexx file is the only file that really does anything. The file
  24. named 'ARexxGuide' is empty. It's only purpose is to hold a place
  25. for the icon file, making it possible to move the icon normally.
  26.  
  27. The icon is set up to call the ARexxGuide.rexx file. It can be
  28. placed in any directory and will successfully launch the guide as
  29. long as long as ARexxGuide.rexx is located in the REXX: directory.
  30.  
  31. Those who wish to show ARexxGuide on a public screen could use the
  32. public screen support in rexxarplib.library to automatically open
  33. it on a public screen.
  34.  
  35.  
  36.  ARx_Guide.xref
  37.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38. When the 'Find Document' menu item is chosen in the AmigaGuide
  39. 'Navigation' menu, the application searches the current database
  40. for the specified name. It will also search any cross-reference
  41. file that has been added. This file tells AmigaGuide where to find
  42. many of the nodes in the guide and makes the Navigation feature
  43. more useful.
  44.  
  45. The .xref file is automatically added by the ARexxGuide.rexx file
  46. described above. It is also used by the help-key macros.
  47.  
  48.  ARx_Help.ttx & ARx_Help.rexx
  49.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50. A readme file for each of these supplemental programs is included
  51. in this directory.
  52.  
  53.                Robin Evans                   16 Oct 1993
  54.  
  55.                   R.EVANS6   on GEnie
  56.  
  57.                   from Internet:
  58.                      robin@halcyon.com
  59.                      r.evans6@genie.geis.com
  60.